home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / p_man / cat3 / X11 / XSendEvent.z / XSendEvent
Encoding:
Text File  |  1998-10-30  |  8.9 KB  |  199 lines
  1.  
  2.  
  3.  
  4.      XXXXSSSSeeeennnnddddEEEEvvvveeeennnntttt((((3333XXXX11111111))))   XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 6666....3333))))    XXXXSSSSeeeennnnddddEEEEvvvveeeennnntttt((((3333XXXX11111111))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           XSendEvent, XDisplayMotionBufferSize, XGetMotionEvents,
  10.           XTimeCoord - send events and pointer motion history
  11.           structure
  12.  
  13.      SSSSYYYYNNNNTTTTAAAAXXXX
  14.           Status XSendEvent(_d_i_s_p_l_a_y, _w, _p_r_o_p_a_g_a_t_e, _e_v_e_n_t__m_a_s_k,
  15.           _e_v_e_n_t__s_e_n_d)
  16.                 Display *_d_i_s_p_l_a_y;
  17.                 Window _w;
  18.                 Bool _p_r_o_p_a_g_a_t_e;
  19.                 long _e_v_e_n_t__m_a_s_k;
  20.                 XEvent *_e_v_e_n_t__s_e_n_d;
  21.  
  22.           unsigned long XDisplayMotionBufferSize(_d_i_s_p_l_a_y)
  23.                   Display *_d_i_s_p_l_a_y;
  24.  
  25.           XTimeCoord *XGetMotionEvents(_d_i_s_p_l_a_y, _w, _s_t_a_r_t, _s_t_o_p,
  26.           _n_e_v_e_n_t_s__r_e_t_u_r_n)
  27.                 Display *_d_i_s_p_l_a_y;
  28.                 Window _w;
  29.                 Time _s_t_a_r_t, _s_t_o_p;
  30.                 int *_n_e_v_e_n_t_s__r_e_t_u_r_n;
  31.  
  32.      AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  33.           _d_i_s_p_l_a_y   Specifies the connection to the X server.
  34.  
  35.           _e_v_e_n_t__m_a_s_k
  36.                     Specifies the event mask.
  37.  
  38.           _e_v_e_n_t__s_e_n_d
  39.                     Specifies the event that is to be sent.
  40.  
  41.           _n_e_v_e_n_t_s__r_e_t_u_r_n
  42.                     Returns the number of events from the motion
  43.                     history buffer.
  44.  
  45.           _p_r_o_p_a_g_a_t_e Specifies a Boolean value.
  46.  
  47.           _s_t_a_r_t
  48.           _s_t_o_p      Specify the time interval in which the events are
  49.                     returned from the motion history buffer.  You can
  50.                     pass a timestamp or _C_u_r_r_e_n_t_T_i_m_e.  _P_o_i_n_t_e_r_W_i_n_d_o_w,
  51.  
  52.           _w         Specifies the window the window the event is to be
  53.                     sent to,.
  54.  
  55.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  56.           The _X_S_e_n_d_E_v_e_n_t function identifies the destination window,
  57.           determines which clients should receive the specified
  58.           events, and ignores any active grabs.  This function
  59.           requires you to pass an event mask.  For a discussion of the
  60.  
  61.  
  62.  
  63.      Page 1                                          (printed 4/30/98)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      XXXXSSSSeeeennnnddddEEEEvvvveeeennnntttt((((3333XXXX11111111))))   XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 6666....3333))))    XXXXSSSSeeeennnnddddEEEEvvvveeeennnntttt((((3333XXXX11111111))))
  71.  
  72.  
  73.  
  74.           valid event mask names, see section 10.3.  This function
  75.           uses the w argument to identify the destination window as
  76.           follows:
  77.  
  78.           +o    If w is _P_o_i_n_t_e_r_W_i_n_d_o_w, the destination window is the
  79.                window that contains the pointer.
  80.  
  81.           +o    If w is _I_n_p_u_t_F_o_c_u_s and if the focus window contains the
  82.                pointer, the destination window is the window that
  83.                contains the pointer; otherwise, the destination window
  84.                is the focus window.
  85.  
  86.           To determine which clients should receive the specified
  87.           events, _X_S_e_n_d_E_v_e_n_t uses the propagate argument as follows:
  88.  
  89.           +o    If event_mask is the empty set, the event is sent to
  90.                the client that created the destination window.  If
  91.                that client no longer exists, no event is sent.
  92.  
  93.           +o    If propagate is _F_a_l_s_e, the event is sent to every
  94.                client selecting on destination any of the event types
  95.                in the event_mask argument.
  96.  
  97.           +o    If propagate is _T_r_u_e and no clients have selected on
  98.                destination any of the event types in event-mask, the
  99.                destination is replaced with the closest ancestor of
  100.                destination for which some client has selected a type
  101.                in event-mask and for which no intervening window has
  102.                that type in its do-not-propagate-mask. If no such
  103.                window exists or if the window is an ancestor of the
  104.                focus window and _I_n_p_u_t_F_o_c_u_s was originally specified as
  105.                the destination, the event is not sent to any clients.
  106.                Otherwise, the event is reported to every client
  107.                selecting on the final destination any of the types
  108.                specified in event_mask.
  109.  
  110.           The event in the _X_E_v_e_n_t structure must be one of the core
  111.           events or one of the events defined by an extension (or a
  112.           _B_a_d_V_a_l_u_e error results) so that the X server can correctly
  113.           byte-swap the contents as necessary. The contents of the
  114.           event are otherwise unaltered and unchecked by the X server
  115.           except to force send_event to _T_r_u_e in the forwarded event
  116.           and to set the serial number in the event correctly;
  117.           therefore these fields and the display field are ignored by
  118.           _X_S_e_n_d_E_v_e_n_t.
  119.  
  120.           _X_S_e_n_d_E_v_e_n_t returns zero if the conversion to wire protocol
  121.           format failed and returns nonzero otherwise.  _X_S_e_n_d_E_v_e_n_t can
  122.           generate _B_a_d_V_a_l_u_e and _B_a_d_W_i_n_d_o_w errors.
  123.  
  124.           The server may retain the recent history of the pointer
  125.           motion and do so to a finer granularity than is reported by
  126.  
  127.  
  128.  
  129.      Page 2                                          (printed 4/30/98)
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.      XXXXSSSSeeeennnnddddEEEEvvvveeeennnntttt((((3333XXXX11111111))))   XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 6666....3333))))    XXXXSSSSeeeennnnddddEEEEvvvveeeennnntttt((((3333XXXX11111111))))
  137.  
  138.  
  139.  
  140.           _M_o_t_i_o_n_N_o_t_i_f_y events.  The _X_G_e_t_M_o_t_i_o_n_E_v_e_n_t_s function makes
  141.           this history available.
  142.  
  143.           The _X_G_e_t_M_o_t_i_o_n_E_v_e_n_t_s function returns all events in the
  144.           motion history buffer that fall between the specified start
  145.           and stop times, inclusive, and that have coordinates that
  146.           lie within the specified window (including its borders) at
  147.           its present placement.  If the server does not support
  148.           motion history, if the start time is later than the stop
  149.           time, or if the start time is in the future, no events are
  150.           returned; _X_G_e_t_M_o_t_i_o_n_E_v_e_n_t_s returns NULL.  If the stop time
  151.           is in the future, it is equivalent to specifying
  152.           _C_u_r_r_e_n_t_T_i_m_e.  _X_G_e_t_M_o_t_i_o_n_E_v_e_n_t_s can generate a _B_a_d_W_i_n_d_o_w
  153.           error.
  154.  
  155.      SSSSTTTTRRRRUUUUCCCCTTTTUUUURRRREEEESSSS
  156.           The _X_T_i_m_e_C_o_o_r_d structure contains:
  157.  
  158.           typedef struct {
  159.                Time time;
  160.                short x, y;
  161.           } XTimeCoord;
  162.  
  163.           The time member is set to the time, in milliseconds. The x
  164.           and y members are set to the coordinates of the pointer and
  165.           are reported relative to the origin of the specified window.
  166.  
  167.      DDDDIIIIAAAAGGGGNNNNOOOOSSSSTTTTIIIICCCCSSSS
  168.           _B_a_d_V_a_l_u_e  Some numeric value falls outside the range of
  169.                     values accepted by the request.  Unless a specific
  170.                     range is specified for an argument, the full range
  171.                     defined by the argument's type is accepted.  Any
  172.                     argument defined as a set of alternatives can
  173.                     generate this error.
  174.  
  175.           _B_a_d_W_i_n_d_o_w A value for a Window argument does not name a
  176.                     defined Window.
  177.  
  178.      SSSSEEEEEEEE AAAALLLLSSSSOOOO
  179.           XAnyEvent(3X11), XIfEvent(3X11), XNextEvent(3X11),
  180.           XPutBackEvent(3X11)
  181.           _X_l_i_b - _C _L_a_n_g_u_a_g_e _X _I_n_t_e_r_f_a_c_e
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.      Page 3                                          (printed 4/30/98)
  196.  
  197.  
  198.  
  199.